Check Configuration

The configuration of the check includes common parameters necessary for any check, along with type-specific parameters. The following sections provide detailed explanations for all configurations. Parameters marked with * are mandatory and must not be left empty.

Common Parameters

• Type*: Either File Check or Database Check. Each type of check refers to a specific part of the system and changes the required configurations.

• Name (ID)*: A unique identifier for this check.

• Description*: A brief explanation of this check's purpose and intention.

• Threshold Type*: The threshold type is typically set automatically. The result will have a type based on your configurations. Possible types include Boolean, String, or Number.
  Example: Executing a Database Check will result in a numeric value, which means that the threshold values must also be numbers.

• Operator*: Available operators are:

  • > (greater)
  • < (less)
  • = (equal)
  • != (not equal)

• Warning Value*: The value for the warning threshold, which depends on Threshold Type. It can be of type String, Number, or a Boolean expression (true or false).

• Error Value*: The value for the error threshold, which also depends on Threshold Type. It can similarly be a String, a Number, or a Boolean expression (true or false).

• Hint*: A suggested solution for issues encountered. This text is displayed if the check detects a problem (either warning or error), providing guidance on how to resolve the issue or suggest next steps.

To maintain traffic light states, two threshold values are required. Evaluation is based on the following rules:

• If <value returned from a command or execution on the system to check> <Operator> <Threshold for warning> evaluates as true, the check's result will be in warning state.
• If <value returned from a command or execution on the system to check> <Operator> <Threshold for error> evaluates as true, the check's result will be in error state.

Examples

Threshold Type: Number

• Result Value = 5
• Warning Threshold = 3
• Error Threshold = 6
• Operator = > (greater)

1. 5 > 3 -> true -> warning
2. 5 > 6 -> false -> no error

Result: The check determines warning as the final state.

• Result Value = 1000
• Warning Value = 1500
• Error Value = 1100
• Operator = < (less)

1. 1000 < 1100 -> true -> warning
2. 1000 < 1500 -> true -> error

Result: The check determines error as the final state (the warning is also true but is overridden by the error).

Threshold Type: String

(For this type of threshold, only the operators = (equal) and != (not equal) are allowed.)

• Result Value = "abc"
• Warning Value = "xyz"
• Error Value = "yz"
• Operator = = (equal)

1. "abc" = "xyz" -> false -> no warning
2. "abc" = "yz" -> false -> no error

Result: The check determines success as the final state.

Threshold Type: Boolean

(For this type of threshold, only operators = (equal) and != (not equal) are allowed.)

note

Because booleans can only be true or false, three distinct states are not possible here. You must decide whether to return an error or warning message in case of an anomaly.

• Result Value = false
• Warning Value = false
• Error Value = true
• Operator = != (not equal)

1. false != false -> false -> no warning
2. false != true -> true -> error

Result: The check determines error as the final state.

File Check

The File Check can assess your file system and supports two kinds of checks: counting files and verifying the existence of a file or path.

Parameters

• Execution Type*:
  Describes the nature of the check. You can choose to count files in a specified path, or check if a specific path or file exists.

• Path*:
  The path to verify.

• Check Parameter*:
  This depends on the execution type:

  • For execution type count, you can specify *, .<file_extension> or xxx*xxx.
  • For execution type exists, you can either leave it blank (to check if the path exists) or provide the name of the file that should exist within the path.

• Writable:
  If set to true, the check will also verify if the path or, in the case of execution type exists, the file is writable.

Database Check

Database Check executes statements on the runtime database of Orchestra, as specified in environment_settings.xml. The essential tables of a running Orchestra instance will be evaluated. To prevent improper or lengthy executions, these statements cannot be altered. The check will run a count statement to determine the number of erroneous records in a table. If this number exceeds a specified limit, a select statement will be executed to identify and display the offending records. The following parameters are set:

Parameters

• Category:
  The category relevant to the check. Each database table corresponds to a specific part of the running Orchestra, such as message, queuing, or housekeeping.

• Table:
  The table on which the check will be executed.

• Condition:
  The condition for the statement:
  select COUNT(*) from <table> where <condition>

• Causer:
  A secondary statement to identify "root cause" records in the table. Typically, this is a standard select statement that executes if the first statement results in an error or warning.

note

Parameters Table, Condition, and Causer are not displayed to avoid exposing Orchestra internals, as they cannot be modified.